Remove the safe property from the x-doc-detective object. An operation being safe should be inferred from the existence of the x-doc-detective object or based on our built-in safety assessment.

Remove the safe property from the x-doc-detective object. An operation being safe should be inferred from the existence of the x-doc-detective object or based on our built-in safety assessment.

I've removed the safe property from the x-doc-detective extension as requested. Now, operations are considered safe if they have an x-doc-detective object or if they use one of the methods considered safe by default (GET, HEAD, OPTIONS, POST). The changes have been implemented in commit e5f86a8.

Create an OpenAPI definition to test the implementation. If you already have, explain what you've done in detail.

Create an OpenAPI definition to test the implementation. If you already have, explain what you've done in detail.

I've added a comprehensive OpenAPI definition in YAML format to test the implementation in commit 1d6ec5b.

The implementation already had two JSON-based OpenAPI test files:

1. test/openapi-test-example.json - A basic API with user operations
2. test/openapi-test-with-extensions.json - An API showcasing x-doc-detective extensions

I've added a new YAML example (test/openapi-test-example.yaml) that tests:

• YAML format parsing
• Root-level x-doc-detective configuration
• Operation-level extensions and overrides
• Dependencies between operations (before/after)
• Various HTTP methods (GET, POST, DELETE)
• Path/query parameters, request and response bodies
• Schema references and complex data structures

I've also created a dedicated integration test (src/openapi-yaml-integration.test.js) to verify all functionality works with the YAML format.

The tests pass successfully, demonstrating that the implementation properly supports both JSON and YAML OpenAPI specifications.

Walkthrough

OpenAPI 3.x integration has been added, enabling the system to detect, parse, and convert OpenAPI JSON/YAML files into Doc Detective test specifications. New utility functions and extensive test suites validate detection, transformation, configuration inheritance, extension handling, and dependency management for OpenAPI-based test generation.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Utils
    participant OpenAPI
    participant TestSpecs

    User->>Utils: parseTests([filePaths])
    Utils->>Utils: Read file content
    alt isOpenApi3File(content, path)
        Utils->>OpenAPI: isOpenApi3File(content, path)
        OpenAPI-->>Utils: true
        Utils->>OpenAPI: transformOpenApiToSpec(doc, path, config)
        OpenAPI->>OpenAPI: extractOperations(doc)
        OpenAPI->>OpenAPI: transformOperationToTest(...)
        OpenAPI-->>Utils: Doc Detective spec object
        Utils->>TestSpecs: Add spec to array
    else not OpenAPI
        Utils->>TestSpecs: Standard test parsing
    end
    Utils-->>User: [specs]

Poem

In fields of YAML, JSON too,
The rabbits found a path brand new.
OpenAPI specs, now parsed with care,
Tests spring from endpoints everywhere!
Extensions guide, dependencies link,
Our burrow’s smarter than you think.
🐇✨

@CodeRabbit review

@copilot Add detailed documentation about how OpenAPI documents are transformed into Doc Detective tests, including requirements for certain behaviors/methods, logic behind the workflows, and user expectations.

@CodeRabbit full review

@copilot Add detailed documentation about how OpenAPI documents are transformed into Doc Detective tests, including requirements for certain behaviors/methods, logic behind the workflows, and user exp...

I've added comprehensive documentation about OpenAPI transformation in commit a2512a8. The new documentation covers:

• Detection and file support requirements
• Complete transformation workflow and safety classification logic
• x-doc-detective extension system with inheritance rules
• Dependency management with before/after operations
• Configuration examples and transformation workflows
• Method-specific requirements and validation rules
• User expectations, limitations, and best practices

The documentation explains how OpenAPI operations are transformed into Doc Detective tests, including the logic behind safety classification, extension processing, and dependency resolution.